﻿//////////////////////////////////////////////////////////////////////////////
//
//  Copyright © 1998-2024 Glodon Company Limited.  All rights reserved.
//
//  Use of this software is subject to the terms of the Glodon license
//  agreement provided at the time of installation or download, or which
//  otherwise accompanies this software in either electronic or hard copy form.  
//
//////////////////////////////////////////////////////////////////////////////

#pragma once

#include "GcmpModelInterface.h"
#include "IEvent.h"

namespace gcmp
{
    class ITransactionEventHandler;
    class IDocument;

    /// \brief 事务事件
    ///
    /// 事务中某些操作执行过程中，会发送相关类型的事务事件
    FINAL_INTERFACE class GCMP_MODEL_INTERFACE_EXPORT ITransactionEvent : public IEvent
    {
        DEFINE_CAST_DERIVED(gcmp::ITransactionEvent, gcmp::IEvent);
    public:
        /// \brief 添加事务事件处理者
        ///
        /// \param pHandler 事务事件处理者
        /// \return 返回true表示添加成功，否则表示失败
        virtual bool Add(ITransactionEventHandler* pHandler) = 0;

        /// \brief 删除事务事件处理者，仅从容器中删除
        ///
        /// \param pHandler 事务事件处理者
        /// \return 返回true表示删除成功，否则表示失败
        virtual bool Delete(ITransactionEventHandler* pHandler) = 0;

        /// \brief 得到发送者对象
        ///
        /// \return 发送者对象
        virtual IDocument* GetSender() const = 0;
    };
}

